Dunning process sent to Aria. Changing the Autopay/non-Autopay should result in Dunning Process updated in Aria
URL
https://[localhost]:[port]/sfdc-ux/v1/{businessId}/billingAccount/{id}
URL PARAMS
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. | Y |
| id | string | unique identifier, in this case account number | Y |
| name | value | description | required |
|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| targetSystem | string | This describes the end system request is for eg, โAriaโ | Y |
| channelId | String | This is the channel to identify the business group eg. โSFDC-B2Cโ | Y |
| lob | String | Line of business | N |
==> Set dunning process with Autopay
cURL request
curl --location --request PATCH 'https:
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'lob: POSTPAID' \
--header 'targetSystem: Aria' \
--header 'channelId: SFDC-B2C' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'Content-Type: application/json' \
--data-raw '{
"defaultPaymentMethod": {
"@referredType": "AutoPay",
"id": "PAYMENT-635",
"name": "AutoPay_Due_10_PR",
"@type":"Credit Card"
},
"relatedParty": [
{
"id": "12345-BG",
"@type": "BillingGroupRef"
}
],
"financialAccount": {
"id": "12345-DG",
"@type": "DunningGroupRef"
},
"characteristic": [
{
"valueType": "string",
"value": "Methods",
"name": "paymentOption"
},
{
"valueType": "any",
"value": 1,
"name": "collections_grp_directive"
},
{
"valueType": "string",
"value": "Medium",
"name": "riskProfileId"
}
]
}'
Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|
| defaultPaymentMethod | object | A payment method reference | Y |
| defaultPaymentMethod.@referredType | string | type of pay. Eg: AutoPay/NonAutoPay | N |
| defaultPaymentMethod.@type | string | Payment method. Eg: ACH/Credit Card | Y |
| defaultPaymentMethod.id | string | Client-defined unique identifier for the payment method. If paymentOption value is 'methods' then it's mandatory | Y* |
| defaultPaymentMethod.name | string | Collection Group ID to which this billing group should be assigned | Y |
| relatedParty | array | A list of related parties | Y |
| relatedParty.id | string | Client-defined unique identifier for billing group | Y |
| relatedParty.@type | string | Type of related party | Y |
| financialAccount | object | A financial account reference | Y |
| financialAccount.id | string | The client-defined identifier of the dunning group. | Y |
| financialAccount.@type | string | Type of financial account | N |
| characteristic | array | A Characteristic. Describes the characteristic of risk profile related to account. Refer the below characteristic table for more info. | Y |
| characteristic.name | string | Name of the characteristic | Y |
| characteristic.value | any | The value of the characteristic | Y |
| characteristic.valueType | string | The value type | N |
characteristic Values
| name | type | description | required |
|---|
| paymentOption | string | This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group' | Y |
| collections_grp_directive | string | Whether to add or remove the collection group to or from the specified billing group. "1 - assign; 2 - remove" | N |
| riskProfileId | string | Client-defined dunning process identifier. | Y |
Response
{
"defaultPaymentMethod": {
"@referredType": "AutoPay",
"id": "PAYMENT-635",
"name": "AutoPay_Due_10_PR",
"@type": "Credit Card"
},
"financialAccount": {
"id": "12345-DG",
"@type": "DunningGroupRef"
},
"characteristic": [
{
"valueType": "string",
"value": "Methods",
"name": "paymentOption"
},
{
"valueType": "any",
"value": 1,
"name": "collections_grp_directive"
},
{
"valueType": "string",
"value": "Medium",
"name": "riskProfileId"
}
],
"accountRelationship": [
{
"account": {
"id": "1469814",
"@type": "billing_group_no",
"@referredType": "BillingAriaAccount"
}
},
{
"account": {
"id": "40337487",
"@type": "stmt_contact_no",
"@referredType": "BillingAriaAccount"
}
},
{
"account": {
"id": "40337460",
"@type": "bill_contact_no",
"@referredType": "BillingAriaAccount"
}
}
],
"relatedParty": [
{
"id": "12345-BG",
"@type": "BillingGroupRef"
}
]
}
Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|
| defaultPaymentMethod | object | A payment method reference | N |
| defaultPaymentMethod.@referredType | string | type of pay. Eg: AutoPay/NonAutoPay | N |
| defaultPaymentMethod.@type | string | Payment method. Eg: ACH/Credit Card | N |
| defaultPaymentMethod.id | string | Client-defined unique identifier for the payment method. | N |
| defaultPaymentMethod.name | string | Collection Group ID to which this billing group should be assigned | N |
| relatedParty | array | A list of related parties | N |
| relatedParty.id | string | Client-defined unique identifier for billing group | N |
| relatedParty.@type | string | Type of related party | N |
| financialAccount | object | A financial account reference | N |
| financialAccount.id | string | The client-defined identifier of the dunning group. | N |
| financialAccount.@type | string | Type of financial account | N |
| characteristic | array | A Characteristic. Describes the characteristic of risk profile related to account. Refer the below characteristic table for more info. | Y |
| characteristic.name | string | Name of the characteristic | N |
| characteristic.value | any | The value of the characteristic | N |
| characteristic.valueType | string | The value type | N |
| accountRelationship | array | Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account. | N |
| accountRelationship.account | object | Account reference. A account may be a party account or a financial account. | N |
| accountRelationship.account.id | string | Unique identifier of the account | N |
| accountRelationship.account.@type | string | Type of account | N |
| accountRelationship.account.@referredType | string | The actual type of the target instance | N |
characteristic Values
| name | type | description | required |
|---|
| paymentOption | string | This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group' | Y |
| collections_grp_directive | string | Whether to add or remove the collection group to or from the specified billing group. "1 - assign; 2 - remove" | N |
| riskProfileId | string | Client-defined dunning process identifier. | N |
accountRelationship values
| name | type | description | required |
|---|
| billing_group_no | string | Aria internal Billing group number | N |
| stmt_contact_no | string | The Aria-assigned unique identifier for the statement contact associated with a billing group on the account. | N |
| bill_contact_no | string | The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. | N |
==> Set dunning process with non-autopay setup
cURL request
curl --location --request PATCH 'https:
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'lob: POSTPAID' \
--header 'targetSystem: Aria' \
--header 'channelId: SFDC-B2C' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'Content-Type: application/json' \
--data-raw '{
"defaultPaymentMethod": {
"@referredType": "NonAutoPay",
"name": "Net_23_Days"
},
"relatedParty": [
{
"id": "12345-BG",
"@type": "BillingGroupRef"
}
],
"financialAccount": {
"id": "12345-DG",
"@type": "DunningGroupRef"
},
"characteristic": [
{
"valueType": "string",
"value": "Terms",
"name": "paymentOption"
},
{
"valueType": "string",
"value": "High",
"name": "riskProfileId"
}
]
}'
Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|
| defaultPaymentMethod | object | A payment method reference | Y |
| defaultPaymentMethod.@referredType | string | type of pay. Eg: AutoPay/NonAutoPay | Y* |
| defaultPaymentMethod.name | string | Collection Group ID to which this billing group should be assigned | Y |
| relatedParty | array | A list of related parties | Y |
| relatedParty.id | string | Client-defined unique identifier for billing group | Y |
| relatedParty.@type | string | Type of related party | Y |
| financialAccount | object | A financial account reference | Y |
| financialAccount.id | string | The client-defined identifier of the dunning group. | Y |
| financialAccount.@type | string | Type of financial account | N |
| characteristic | array | A Characteristic. Describes the characteristic of risk profile related to account. Refer the below characteristic table for more info. | Y |
| characteristic.name | string | Name of the characteristic | Y |
| characteristic.value | string | The value of the characteristic | Y |
characteristic Values
| name | type | description | required |
|---|
| paymentOption | string | This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group' | Y |
| riskProfileId | string | Client-defined dunning process identifier. | Y |
Response
{
"defaultPaymentMethod": {
"@referredType": "NonAutoPay",
"name": "Net_23_Days"
},
"financialAccount": {
"id": "12345-DG",
"@type": "DunningGroupRef"
},
"characteristic": [
{
"valueType": "string",
"value": "Terms",
"name": "paymentOption"
},
{
"valueType": "string",
"value": "High",
"name": "riskProfileId"
}
],
"accountRelationship": [
{
"account": {
"id": "1469814",
"@type": "billing_group_no",
"@referredType": "BillingAriaAccount"
}
},
{
"account": {
"id": "40337487",
"@type": "stmt_contact_no",
"@referredType": "BillingAriaAccount"
}
}
],
"relatedParty": [
{
"id": "12345-BG",
"@type": "BillingGroupRef"
}
]
}
Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|
| defaultPaymentMethod | object | A payment method reference | N |
| defaultPaymentMethod.@referredType | string | type of pay. Eg: AutoPay/NonAutoPay | N |
| defaultPaymentMethod.name | string | Collection Group ID to which this billing group should be assigned | N |
| relatedParty | array | A list of related parties | N |
| relatedParty.id | string | Client-defined unique identifier for billing group | N |
| relatedParty.@type | string | Type of related party | N |
| financialAccount | object | A financial account reference | N |
| financialAccount.id | string | The client-defined identifier of the dunning group. | N |
| financialAccount.@type | string | Type of financial account | N |
| characteristic | array | A Characteristic. Describes the characteristic of risk profile related to account. Refer the below characteristic table for more info. | N |
| characteristic.name | string | Name of the characteristic | N |
| characteristic.value | any | The value of the characteristic | N |
| characteristic.valueType | any | The value type | N |
characteristic Values
| name | type | description | required |
|---|
| paymentOption | string | This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group' | N |
| riskProfileId | string | Client-defined dunning process identifier. | N |
accountRelationship values
| name | type | description | required |
|---|
| billing_group_no | string | Aria internal Billing group number | N |
| stmt_contact_no | string | The Aria-assigned unique identifier for the statement contact associated with a billing group on the account. | N |
| bill_contact_no | string | The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. | N |